OPC Studio User's Guide and Reference
ReadValueFunction(UADataVariable,Type,Func<Object>) Method
Example 



OpcLabs.ServerOpcUA Assembly > OpcLabs.EasyOpc.UA.NodeSpace Namespace > UADataVariableExtension Class > ReadValueFunction Method : ReadValueFunction(UADataVariable,Type,Func<Object>) Method
The data variable that will be modified and returned.

The value of this parameter cannot be null (Nothing in Visual Basic).

The type of the data variable, expressed as .NET System.Type.

The value of this parameter cannot be null (Nothing in Visual Basic).

The read value function, i.e. the function that performs the read operation and returns the value that will be returned to the caller of the OPC UA Read.

The value of this parameter cannot be null (Nothing in Visual Basic).

Specifies value type and read value function, for the pull data provision model.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ReadValueFunction( _
   ByVal dataVariable As UADataVariable, _
   ByVal valueType As Type, _
   ByVal readValueFunction As Func(Of Object) _
) As UADataVariable
'Usage
 
Dim dataVariable As UADataVariable
Dim valueType As Type
Dim readValueFunction As Func(Of Object)
Dim value As UADataVariable
 
value = UADataVariableExtension.ReadValueFunction(dataVariable, valueType, readValueFunction)
[Extension()]
[NotNull()]
public static UADataVariable ReadValueFunction( 
   UADataVariable dataVariable,
   Type valueType,
   Func<object> readValueFunction
)

Parameters

dataVariable
The data variable that will be modified and returned.

The value of this parameter cannot be null (Nothing in Visual Basic).

valueType
The type of the data variable, expressed as .NET System.Type.

The value of this parameter cannot be null (Nothing in Visual Basic).

readValueFunction
The read value function, i.e. the function that performs the read operation and returns the value that will be returned to the caller of the OPC UA Read.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns the dataVariable, internally modified as defined by the method.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This method always makes the data variable readable, but that does not mean it automatically makes it non-writable. If you need a data variable that is readable and non-writable, combine this method with calling Writable(UADataVariable,Boolean) method with the 'writable' parameter set to false.

The status code will be "Good", and the timestamp will be the current time after the read function has been called.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Example
// This example shows how to create a data variable of type UInt16 and implement reading its value using a function.
// You can use any OPC UA client, including our Connectivity Explorer and OpcCmd utility, to connect to the server. 
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
// OPC client, server and subscriber examples in C# on GitHub: https://github.com/OPCLabs/Examples-OPCStudio-CSharp .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.

using System;
using OpcLabs.EasyOpc.UA;
using OpcLabs.EasyOpc.UA.NodeSpace;

namespace UAServerDocExamples._UADataVariable
{
    partial class ReadValueFunction
    {
        public static void UInt16()
        {
            // Instantiate the server object.
            // By default, the server will run on endpoint URL "opc.tcp://localhost:48040/".
            var server = new EasyUAServer();

            // Create a data variable, defining its read values by a function.
            // We explicitly specify the OPC data type of the variable to be UInt16. The read value function can then return
            // any type of object, and OPC Wizard will attempt to convert it to the specified OPC data type. This is helpful
            // in languages like VB.NET that do not have full support for some types (such as unsigned integers).
            var random = new Random();
            server.Add(new UADataVariable("ReadThisVariable").ReadValueFunction(
                typeof(UInt16), () => random.Next(65536)));

            // Start the server.
            Console.WriteLine("The server is starting...");
            server.Start();

            Console.WriteLine("The server is started.");
            Console.WriteLine();

            // Let the user decide when to stop.
            Console.WriteLine("Press Enter to stop the server...");
            Console.ReadLine();

            // Stop the server.
            Console.WriteLine("The server is stopping...");
            server.Stop();

            Console.WriteLine("The server is stopped.");
        }
    }
}
' This example shows how to create a data variable of type UInt16 and implement reading its value using a function.
' You can use any OPC UA client, including our Connectivity Explorer and OpcCmd utility, to connect to the server. 
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-OpcStudio/Latest/examples.html .
' OPC client and subscriber examples in VB.NET on GitHub: https://github.com/OPCLabs/Examples-QuickOPC-VBNET .
' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
' a commercial license in order to use Online Forums, and we reply to every post.

Imports System
Imports OpcLabs.EasyOpc.UA
Imports OpcLabs.EasyOpc.UA.NodeSpace

Namespace _UADataVariable
    Partial Friend Class ReadValueFunction
        Shared Sub UInt16()
            ' Instantiate the server object.
            ' By default, the server will run on endpoint URL "opc.tcp://localhost:48040/".
            Dim server = New EasyUAServer()

            ' Create a data variable, defining its read values by a function.
            ' We explicitly specify the OPC data type of the variable to be UInt16. The read value function can then return
            ' any type of object, and OPC Wizard will attempt to convert it to the specified OPC data type. This is helpful
            ' in languages like VB.NET that do not have full support for some types (such as unsigned integers).
            Dim random = New Random()
            server.Add(New UADataVariable("ReadThisVariable").ReadValueFunction(
                GetType(UInt16), Function() random.Next(65536)))

            ' Start the server.
            Console.WriteLine("The server is starting...")
            server.Start()

            Console.WriteLine("The server is started.")
            Console.WriteLine()

            ' Let the user decide when to stop.
            Console.WriteLine("Press Enter to stop the server...")
            Console.ReadLine()

            ' Stop the server.
            Console.WriteLine("The server is stopping...")
            server.Stop()

            Console.WriteLine("The server is stopped.")
        End Sub
    End Class
End Namespace
Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also